ARROW-15006: [Python][Doc] Add five more numpydoc checks to CI#15214
Conversation
|
Hey @jorisvandenbossche, since you reviewed the last numpydoc PR, would you want to take a look here? This adds five of the ten checks we discussed (Jira, Google Sheet) adding and the diff is relatively straightforward compared to the last one. |
|
Thanks for the review @wjones127. This is ready for another look. |
wjones127
left a comment
wjones127
left a comment
There was a problem hiding this comment.
Saw a couple more instances of description in the type spot.
Also not going to correct the periods missing from end of description, since we aren't planning on enforcing PR09 and RT05, but did include that correct in my examples. (I know Joris has asked this of my PRs in the past.)
Co-authored-by: Will Jones <willjones127@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
|
Thanks @wjones127, those look good. The help is appreciated :) |
|
Benchmark runs are scheduled for baseline = a580f27 and contender = 14ec80f. 14ec80f is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
|
['Python', 'R'] benchmarks have high level of regressions. |
…e#15214) This adds the numpydoc checks GL10, PR04, PR05, RT03, and YD01 to CI and fixes the associated issues in docstrings. These checks are: - GL10: reST directives {directives} must be followed by two colons - PR04: Parameter "{param_name}" has no type - PR05: Parameter "{param_name}" type should not finish with "." - RT03: Return value has no description - YD01: No Yields section found https://numpydoc.readthedocs.io/en/latest/validation.html Lead-authored-by: Bryce Mecum <petridish@gmail.com> Co-authored-by: Will Jones <willjones127@gmail.com> Signed-off-by: Will Jones <willjones127@gmail.com>
3 participants
This adds the numpydoc checks GL10, PR04, PR05, RT03, and YD01 to CI and fixes the associated issues in docstrings.
These checks are:
https://numpydoc.readthedocs.io/en/latest/validation.html